Overview | Package | Class | Tree | Deprecated | Index | Help			Java Platform 1.1.7
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.JToolBar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--com.sun.java.swing.JComponent
                    |
                    +--com.sun.java.swing.JToolBar

public class JToolBar

extends JComponent

implements Accessible

JToolBar provides a component which is useful for displaying commonly used Actions or controls. It can be dragged out into a seperate window by the user (unless the floatable property is set to false). In order for drag-out to work correctly, it is recommended that you add JToolBar instances to one of the four 'sides' of a container whose layout manager is a BorderLayout, and do not add children to any of the other four 'sides'.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JToolBar key assignments.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:

Action, Serialized Form

Inner Class Summary

	JToolBar.AccessibleJToolBar The class used to obtain the accessible role for this object.
	JToolBar.Separator A toolbar-specific separator.

Inner classes inherited from class com.sun.java.swing.JComponent

JComponent.AccessibleJComponent

Fields inherited from class com.sun.java.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

JToolBar()
Create a new toolbar.

Method Summary

JButton	add(Action a) Add a new JButton which dispatches the action.
void	addSeparator() Appends a toolbar-specific separator to the end of the toolbar (not a JSeparator).
java.beans.PropertyChangeListener	createActionChangeListener(JButton b)
AccessibleContext	getAccessibleContext() Get the AccessibleContext associated with this JComponent
java.awt.Component	getComponentAtIndex(int i)
int	getComponentIndex(java.awt.Component c)
java.awt.Insets	getMargin() Returns the margin between the toolbar's border and its buttons.
java.lang.String	getUIClassID() Returns the name of the L&F class that renders this component.
com.sun.java.swing.plaf.ToolBarUI	getUI() Returns the toolbar's current UI.
boolean	isBorderPainted() Checks whether the border should be painted.
boolean	isFloatable() Return true if the Toolbar can be dragged out by the user.
void	paintBorder(java.awt.Graphics g) Paint the toolbar's border if BorderPainted property is true.
void	setBorderPainted(boolean b) Sets whether the border should be painted.
void	setFloatable(boolean b) Sets whether the toolbar can be made to float
void	setMargin(java.awt.Insets m) Sets the margin between the toolbar's border and its buttons.
void	setUI(com.sun.java.swing.plaf.ToolBarUI ui) Sets the L&F object that renders this component.
void	updateUI() Notification from the UIFactory that the L&F has changed.

Methods inherited from class com.sun.java.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paint, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setBounds, setDebugGraphicsOptions, setDoubleBuffered, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponentAt, getComponentAt, getComponent, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, paint, paramString, preferredSize, printComponents, print, processContainerEvent, processEvent, removeAll, remove, remove, removeContainerListener, removeNotify, setLayout, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paint, paramString, postEvent, preferredSize, prepareImage, prepareImage, printAll, print, processComponentEvent, processEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Constructor Detail

JToolBar

public JToolBar()

Create a new toolbar.

Method Detail

getUI

public com.sun.java.swing.plaf.ToolBarUI getUI()

Returns the toolbar's current UI.

See Also:

setUI

setUI

public void setUI(com.sun.java.swing.plaf.ToolBarUI ui)

Sets the L&F object that renders this component.

Parameters:

ui - the ToolBarUI L&F object

See Also:

getUI

updateUI

public void updateUI()

Notification from the UIFactory that the L&F has changed. Called to replace the UI with the latest version from the UIFactory.

Overrides:

updateUI in class JComponent

See Also:

updateUI

getUIClassID

public java.lang.String getUIClassID()

Returns the name of the L&F class that renders this component.

Returns:

"ToolBarUI"

Overrides:

getUIClassID in class JComponent

See Also:

getUIClassID, getUI

getComponentIndex

public int getComponentIndex(java.awt.Component c)

getComponentAtIndex

public java.awt.Component getComponentAtIndex(int i)

setMargin

public void setMargin(java.awt.Insets m)

Sets the margin between the toolbar's border and its buttons. Setting to null causes the toolbar to use the default margins. The toolbar's default Border object uses this value to create the proper margin. However, if a non-default border is set on the toolbar, it is that Border object's responsibility to create the appropriate margin space (otherwise this property will effectively be ignored).

Parameters:

m - an Insets object that defines the space between the border and the buttons

See Also:

java.awt.Insets

getMargin

public java.awt.Insets getMargin()

Returns the margin between the toolbar's border and its buttons.

Returns:

an Insets object containing the margin values

See Also:

java.awt.Insets

isBorderPainted

public boolean isBorderPainted()

Checks whether the border should be painted.

Returns:

true if the border should be painted, else false

See Also:

setBorderPainted

setBorderPainted

public void setBorderPainted(boolean b)

Sets whether the border should be painted.

Parameters:

b - if true, the border is painted.

See Also:

isBorderPainted

paintBorder

protected void paintBorder(java.awt.Graphics g)

Paint the toolbar's border if BorderPainted property is true.

Parameters:

g - the Graphics context in which the painting is done

Overrides:

paintBorder in class JComponent

See Also:

paint, setBorder

isFloatable

public boolean isFloatable()

Return true if the Toolbar can be dragged out by the user.

Returns:

true if the Toolbar can be dragged out by the user

setFloatable

public void setFloatable(boolean b)

Sets whether the toolbar can be made to float

Parameters:

b - if true, the toolbar can be dragged out

See Also:

isFloatable

addSeparator

public void addSeparator()

Appends a toolbar-specific separator to the end of the toolbar (not a JSeparator).

add

public JButton add(Action a)

Add a new JButton which dispatches the action.

Parameters:

a - the Action object to add as a new menu item

createActionChangeListener

protected java.beans.PropertyChangeListener createActionChangeListener(JButton b)

getAccessibleContext

public AccessibleContext getAccessibleContext()

Get the AccessibleContext associated with this JComponent

Specified by:

getAccessibleContext in interface Accessible

Returns:

the AccessibleContext of this JComponent

Overrides:

getAccessibleContext in class JComponent